cs-seguridad-social-sapi

This section provides the meaning of the attributes included in the API.

🗂️ Base Information

• API Title: CS Seguridad Social API
• Version: 1.0.0
• Base URL:

  https://api.example.com/cs-seguridad-social

🔑 API KEYS

• "Authorization": "Bearer {{API_KEY}}"Attribute defined in the request Header.

  • Type: String
  • Length: Minimum 36 characters, maximum 37 characters
  • Description: Authentication token required to access the API.

• "client_id": "{{CLIENT_ID}}"Attribute defined in the request Header.

  • Type: String
  • Length: Minimum 32 characters, maximum 36 characters
  • Description: Unique client identifier to authenticate the request.

NOTE: It is important to have these API KEYS to make any request to our services.

💼 Employers (Endpoints: /v1/employers)

• "id"

  • Type: String
  • Description: Unique identifier for the employer.

• "name"

  • Type: String
  • Max Length: 100 characters
  • Description: Name of the employer.

• "identificationNumber"

  • Type: String
  • Max Length: 20 characters
  • Description: Employer's tax identification number.

• "address"

  • Type: String
  • Max Length: 255 characters
  • Description: Registered address of the employer.

💼 Employees (Endpoints: /v1/employees)

• "id"

  • Type: String
  • Description: Unique identifier for the employee.

• "name"

  • Type: String
  • Max Length: 100 characters
  • Description: Full name of the employee.

• "identificationNumber"

  • Type: String
  • Max Length: 20 characters
  • Description: National ID or passport number of the employee.

• "employerId"

  • Type: String
  • Description: Identifier of the employer associated with the employee.

🏥 Health Providers (Endpoints: /v1/health-providers)

• "id"

  • Type: String
  • Description: Unique identifier for the health provider.

• "name"

  • Type: String
  • Max Length: 100 characters
  • Description: Name of the health provider.

• "registrationNumber"

  • Type: String
  • Max Length: 20 characters
  • Description: Official registration number of the health provider.

• "location"

  • Type: String
  • Max Length: 255 characters
  • Description: Address of the health provider.

💳 Payments (Endpoints: /v1/payments)

• "id"

  • Type: String
  • Description: Unique identifier for the payment.

• "amount"

  • Type: Number
  • Description: Amount paid for social security services.

• "date"

  • Type: DateTime
  • Description: Date of the payment transaction.

• "payerId"

  • Type: String
  • Description: Identifier of the entity making the payment.

⚠️ Error Codes

📞 Support

For assistance, contact the Integration Services and Applications Coordination team.

Email: epalma@fgs

Last updated: April 2025